OTSetAddressFromNBPEntity
Stores an NBP entity structure as an NBP address string.C INTERFACE
size_t OTSetAddressFromNBPEntity (UInt8* nameBuf, const NBPEntity* nbpEntity);C++ INTERFACES
None. C++ applications use the C interface to this function.PARAMETERS
nameBuf
- A pointer to the NBP address buffer in which you wish to store the NBP entity.
nbpEntity
- A pointer to the NBP entity you wish to store.
DESCRIPTION
TheOTSetAddressFromNBPEntity
function stores the information in the NBP entity into the buffer specified by thenameBuf
parameter in the format required for mapper calls--that is, if you have a backslash (\), a colon (:), or an at-sign (@) in your NBP name, this function inserts a backslash before each so that the mapper functions can handle them correctly. This function returns the number of bytes that were actually used in the buffer.SPECIAL CONSIDERATIONS
Use theOTGetNBPEntityLengthAsAddress
function beforehand to determine the appropriate buffer size.SEE ALSO
The NBP entity structure is described in the section "The NBP Entity Structure," beginning on page 10-20.The NBP address structure is described in the section "The NBP Address Structure," beginning on page 10-17.
To determine the appropriate buffer size for an NBP entity, use the
OTGetNBPEntityLengthAsAddress
function (page 10-26).To parse and store all or part of an NBP name into an NBP entity, use the
OTSetNBPEntityFromAddress
function (page 10-28).